// Copyright 2009 Andy Kernahan
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;

namespace AK.F1.Timing.Live
{
    /// <summary>
    /// Defines the overall state of a <see cref="LiveMessageReader"/>.
    /// </summary>
    [Serializable]
    internal enum LiveMessageReaderState
    {
        /// <summary>
        /// The reader is an uninitialised state and has yet to perform a read.
        /// </summary>
        Uninitialised,
        /// <summary>
        /// The reader is initialised and is currently dequeuing / reading messages.
        /// </summary>
        Reading,
        /// <summary>
        /// The reader has read a terminal message and is closed. Any further invocations of
        /// <see cref="M:AK.F1.Timing.Live.LiveMessageReader.Read"/> will return <see langword="null"/>.
        /// </summary>
        Closed
    }
}